home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lDump.3 < prev    next >
Text File  |  1993-08-08  |  793b  |  34 lines
  1. '.so tmac.clman
  2. .TH "lDump"
  3. .IX lDump
  4. .SH NAME
  5. lDump - Dump a linked list to a file.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lDump" "(id, file)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    id    identifier of linked list
  13. .br
  14. .RP
  15. In    char    *file    name of linked list dump file
  16. .DT
  17. .SH DESCRIPTION
  18. \fBlDump\fP is a linked list dumping utility. It allows the user to store
  19. linked list data in a specially formatted file, so the linked list data can
  20. be used within another program session. This file can be read by the linked
  21. list undumping utility lUndump.
  22. .br
  23. Don't use pointers within your data structure, because only the pointers
  24. will be written in the dump file, not the data pointed to.
  25. .SH RETURN CODES
  26. .nf
  27. Return on success :
  28.     lSUCCESS
  29. Return on error :
  30.     lUNKNOWN_ID, lOPEN_ERROR
  31. .fi
  32. .SH AUTHOR
  33. Anita Eijs (TNO - Bouw - BouwInformatica)
  34.